Customer Management Biz Api

(0 reviews)

JM - GET CustomerByID

GET (TMF-629)

This operation allows the users to retrieve the customer with operation GET from the BSS system and apply the transformations if required to maintain the standards with TMF.

URL

For ONPREM:

http://[localhost]:[port]tmf-api/customerManagement/v1/{businessId}/customer/{id}

Base URI Parameter

Name	Type	M/O	Description
businessId	string	M	Business unit identifier. Example: “JM”

Headers

name	value	description	required
X-Correlation-ID	string	This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b	O
channeId	string	Channel to business: Expected Value: "SFDC-B2C"	M
lob	String	Enum: PREPAID, POSTPAID,FIXED	O

Security Headers

name	value	description	required
client_id	string	Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg:6f0ed16a7b494d76b2d60e05bc3b3332	M
client_secret	string	Client secret value for Client Id Enforcement policy. Environment Specific Value Eg: e4CD4D43449846aA9D8Cb9c43fAd324a	M

Query Param

name	type	description	required
id	string	customer number or customer account number	M

HTTP Status response is 200

Response Sample for JM.

{
   {
    "id": "33711223",
    "name": "MR Test Account",
    "status": "W-Working",
    "characteristic": [
        {
            "name": "system",
            "value": "Liberate"
        },
        {
            "name": "dateOfBirth",
            "value": "1956-02-26T00:00:00"
        },
        {
            "name": "title",
            "value": "MR"
        },
        {
            "name": "type",
            "value": "A-Cellular Pre-paid"
        },
        {
            "name": "subType",
            "value": "New Fixed|Existing Mobile"
        },
        {
            "name": "identificationNumber",
            "value": "112233441",
            "valueType": "TR"
        }
    ],
    "contactMedium": [
        {
            "mediumType": "Address",
            "characteristic": {
                "street1": "24 LiLEICESTERFIELD",
                "street2": "Nine Turn",
                "stateOrProvince": "Clarendon",
                "city": "Jamaica W.I"
            }
        }
    ],
    "account": [
        {
            "id": "334455660000",
            "name": "MR Test Account",
            "@type": "BillingAccount"
        }
    ]
}
}

Definitions

Each of the request parameters is detailed.

name	type	description	required
id	string	Consumer Account Number generated	N
href	string	reference the customer	N
state	string	Status of the account: Working, Suspend, Disconnected N
account	array	Billing Account Number	N
account.id	string	name of the billing account	N
account.name	string	account type	N
account.@type	string	account type	N
contactMedium.mediumType	string	type of contact, Eg: Address, email, Telephone	N
contactMedium.preferred	boolean	preferred	N
contactMedium.characteristic.street1	string	Address Line 1	N
contactMedium.characteristic.street2	string	Address Line 2	N
contactMedium.characteristic.stateOrProvince	string	Name of Province	N
contactMedium.characteristic.city	string	Name of city	N
contactMedium.characteristic.phoneNumber	string	phone number of the contact	N
contactMedium.characteristic.emailAddress	string	email address of the contact	N
contactMedium.characteristic.contactType	string	indicates Primary or Secondary contact for the Customer account	N
contactMedium.@referredType	string	referred type of contactMedium	N
characteristic	array	characteristic values, refer below table for more details	N
characteristic.name	string	Name of the characteristic	N
characteristic.value	string	Value of the characteristic	N

Characteristic Values

name	type	description	required
system	string	Billing system name Liberate or Cerillion	N
dateOfBirth	string	date of birth	N
firstName	string	First name of the customer	N
lastName	string	last name of the customer	N
identificationType	string	Customer Identification type	N
identificationNumber	string	Customer Identification Number	N
language	string	preferred language by the customer for communication	N